Organisation API

The webservice is exposed in REST and is secured and client_id/client_secret enabled.

• Following request headers for all request :

Content-type: application/json
client_id: {client_id provided by Dali}
client_secret: {client_secret provided by Dali}

GROUPS

This operation gets the group details by his id

REQUEST

url: /rest/v1/groups
URI parameters:
groupsId=Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "groupRocId": Entity ID in the ROC,
        "groupCode": "Group Code ",
        "groupName": "Group Name",
        "vinciGroupName": "Vinci Group Name",
        "activeFlag": "Entity active or not",
        "currencyId": Currency ID,
        "directorRocId":ROC ID of the Entity Manager
    },
    "error": {}
}

DIVISIONS

This operation gets the division details by his id

REQUEST

url: /rest/v1/divisions
URI parameters:
divisionId=Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "divisionRocId": Entity ID in the ROC,
        "divisionCode": "Division Code",
        "divisionName": "Division Name",
        "divisionVinciName": "Vinci Division Name",
        "editOrder": Entity edition order,
        "activeFlag": "Entity active or not",
        "currencyId": Currency ID,
        "countryId": Country ID,
        "languageId": Language ID,
        "groupRocId": Group roc id,
        "scopeId": Scope ID,
        "divisionShortCode": "Short Code of the division",
        "divisionShortName": "Short Name of the division",
        "directorRocId": Director ID in the ROC
    },
    "error": {}
}

POLES

This operation gets the pole details by his id

REQUEST

url: /rest/v1/poles
URI parameters:
poleId: Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "poleRocId": Entity ID in the ROC,
        "poleName": "Pole name",
        "poleVinciName": "Pole Vinci name",
        "poleCode": "Pole Code",
        "editOrder": Entity edition order,
        "activeFlag": "Entity active or not",
        "currencyId": Currency ID,
        "countryId": Country ID,
        "languageId": Language ID,
        "divisionRocId": Division roc id,
        "scopeId": Scope id,
        "directorRocId": Director ID in the ROC,
        "poleShortCode": "Pole short code in the ROC",
        "poleShortName": "Pole short name in the ROC"
    },
    "error": {

    }
}

MANAGEMENTS

This operation gets the management details by his id.

REQUEST

url: /rest/v1/managements
URI parameters:
managementId: Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "managementRocId": Entity ID in the ROC,
        "managementName": "Management name",
        "managementVinciName": "Management Vinci name",
        "managementCode": "Management code",
        "editOrder": "Entity edition order",
        "activeFlag": "Entity active or not",
        "currencyId": Currency ID,
        "countryId": Country ID,
        "languageId": Language ID,
        "managementType": "Management type",
        "poleRocId": Pole roc ID,
        "activityManagementRocId": Entity ID in the Roc,
        "scopeId": Scope ID,
        "directorRocId": Director ID in ROC,
        "directorCode":"Director Code in ROC on 8 characters"
    },
    "error": {

    }
}

COMPANIES

This operation gets the companies details by his id.

REQUEST

url: /rest/v1/companies
URI parameters:
companyId: Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "companyRocId": Company roc id,
        "companyName": "Company Name",
        "companyVinciName": "VINCI company name",
        "companyShortName": "Short company name",
        "companyLongName": "Long company nae",
        "companyOsmose": "OSMOSE code",
        "activeFlag": "Entity active or not",
        "editOrder": Edit order,
        "currencyId": "Currency ID",
        "languageId": Language ID,
        "countryId": Country ID,
        "companyAnalyticalCode": "Analytical Code",
        "companyType": Type,
        "applications": [
            {
                "applicationId": Application ID,
                "applicationName": "Application Name",
                "activeFlag": "Application active or not"
          }
        ],
        "poleRocId": Entity ID in the ROC,
        "managementRocId": Entity ID in the ROC,
        "siret": "SIRET",
        "postalCode": "Postal Code",
        "addressL1": "Adress Line 1",
        "addressL2": "Adress Line 2",
        "addressL3": "Adress Line 3",
        "town": "Town",
        "email": "Email",
        "telephone": "Phone Number",
        "fax": "Fax",
        "apeCode": "APE Code",
        "vatIntracom": "VAT Intracom",
        "legalStatus": "Legal Status",
        "legalDetention": "Legal Detention",
        "hrSoftwareCode": "HR Software code",
        "softwares": [
            {
                "uniqueKey": "Unique Key",
                "softwareId": "Software ID",
                "softwareName": "Software Name",
                "softwareTypeId": "Software Type ID",
                "softwareTypeName": "Software Type name",
                "divisionName": "Division Name",
                "poleName": "Pole Name",
                "companyName": "Company Name",
                "companyOsmose": "OSMOSE Code"
            }
        ],
        "dematIntraVEFlag": "Demat Intra VE",
        "dematDFIVinciFlag": "Demat DFI Vinci",
        "assuranceCode": "Assurance Code",
        "consolidatedFlag": "Consolidated",
        "businessAssuranceTreeFlag": "Business Assurance Tree Flag",
        "dematOperator": "Demat Operator",
        "cbcrActivityId": CBCR Activity ID,
        "fiscalIdentifier": "Fiscal Identifier",
        "taxRegimeId": Tax regime ID,
        "billingAddress": "Billing Address",
        "billingAddressC1": "Billing Address C1",
        "billingAddressC2": "Billing Address C2",
        "billingTown": "Billing Town",
        "billingPostalCode": "Billing postal code",
        "billingCountryId": Biling country ID,
        "softwareAccountAna": Software account ana,
        "scopeId": Scope ID
        "idFinancialManager":"Finance Manager ID in ROC",
    },
    "error": {

    }
}

BUSINESS UNITS

REQUEST

This operation gets the business unit details by his id.

url: /rest/v1/business-units
URI parameters:
businessUnitId: Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "businessUnitRocId": Entity ID in the ROC,
        "businessUnitName": "Business Unit name",
        "businessUnitLongName": "Business Unit long Name",
        "businessUnitShortName": "Business Unit Short Name",
        "vinciBusinessUnitName": "VINCI Business Unit Name",
        "businessUnitCode": "Business Unit Code",
        "editOrder": Entity edition order,
        "activeFlag": "Entity active or not",
        "currencyId": Currency ID,
        "countryId": Country ID,
        "languageId": Language ID,
        "businessUnitType": Business Unit type,
        "applications": [
            {
                "applicationId": Application ID,
                "applicationName": "Application Name",
                "activeFlag": "Application active or not"
            }
        ],
        "managementRocId": Management ROC ID,
        "poleRocId": Pole ROC ID,
        "companyRocId": Company ROC ID,
        "businessUnitOsmose": "Business Unit OSMOSE",
        "siret": "Business Unit SIRET",
        "brandId": Brand ROC ID,
        "networkId": Network ROC ID,
        "activityId": Activity ROC ID,
        "consoId": Business Unit Conso ID,
        "addressL1": "Address Line 1",
        "addressL2": "Address Line 2",
        "addressL3": "Address Line 3",
        "postalCode": "Postal Code",
        "town": "Town",
        "addressCountryId": Address Country ID,
        "telephone": "Phone number",
        "fax": "Fax",
        "email": "Email",
        "softwareAccountAna": Software Account ana,
        "hrSoftwareCode": "HR Software Code",
        "latitude": "Latitude",
        "longitude": "Longitude",
        "publiPostageFlag": "Publi postage",
        "visibleAnnuaireFlag": "Visible Annuare or not",
        "assuranceCode": Assurance Code,
        "scopeId": Scope ID,
        "qfqFilledFlag": "QFQ Filled or not",
        "qfqLastUpdate": "Last Update Date of QFQ",
        "hrSoftwareCodeCompany": "HR Software code of the company in ROC",
        "businessManagerRocId": "BU Manager ID in ROC"
    },
    "error": {

    }
}

ACTIVITY MANAGEMENTS

This operation gets the activity management details by his id.

REQUEST

url: /rest/v1/activity-managements
URI parameters:
activityManagementId: Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "activityManagementRocId": "Entity ID in the ROC",
        "activityManagementName": "Activity Management name",
        "activityManagementVinciName": "VINCI Activity Management Name",
        "activityManagementCode": "Activity Management code",
        "editOrder": "Entity edition order",
        "activeFlag": "Entity active or not",
        "currencyId": Currency ID,
        "countryId": Country ID,
        "languageId": Language ID,
        "poleRocId": Pole ROC ID,
        "scopeId": Scope ID,
        "directorRocId": Director ID in ROC
    },
    "error": {

    }
}

PERMANENT ESTABLISHMENTS

This operation gets the permanent establishment details by his id.

REQUEST

url: /rest/v1/permanent-establishments
URI parameters:
permanentEstablishmentId: Entity ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "permanentEstablishmentRocId": Entity ID in the ROC,
        "companyRocId": Company ID,
        "cbcrActivityRocId": CBCR Activity ID,
        "activeFlag": "Active or not",
        "permanentEstablishmentName": "Permanent Establishment Name",
        "legalForm": "Legal Form",
        "revId": "Rev ID",
        "permanentEstablishmentOsmose": "OSMOSE",
        "town": "Town",
        "countryId": Country ID,
        "currencyId": Currency ID,
        "registrationPlace": Registration place,
        "statusId": Status ID,
        "consolidatedFlag": "Consolidated or not",
        "fiscalIdentifier": "Fiscal Identifier",
        "fiscalIntegrationFlag": "Fiscal Integration Flag",
        "startDateFiscalIntegration": Fiscal Integration Start Date,
        "fiscalGroupId": Fiscal group ID,
        "dematFiscalFlag": "Demat fiscally or not",
        "dematOperator": Demat Operator,
        "creationDateES": "ES Creation date",
        "liquidationDate": "Liquidation date",
        "addressL1": "Adress Line 1",
        "addressL2": "Adress Line 2",
        "addressL3": "Adress Line 3",
        "postalCode": "Postal Code",
        "assuranceCode": "Assurance Code",
        "physicalCreationDate": "Physical creation date",
        "scopeId": Scope ID
    },
    "error": {

    }
}

BRAND

This operation gets the brand details by his id.

REQUEST

url: /rest/v1/brands
URI parameters:
brandId: Parameter ID in the ROC
Query parameter:
languageCode=FR

RESPONSE

{
"header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "brandRocId": Brand ID in the ROC,
        "entityTypeId": Entity Type ID,
        "brandShortCode": "Short code brand",
        "brandName": [
            {
                "name": "Name",
                "language": "Brand name language"
            }
         ],
        "editOrder": Entity edition order,
        "activeFlag": "Entity active or not",
        "languageCode": "Language code"
      },
      "error": {

    }
}

ACTIVITIES

This operation gets the activity details by his id.

REQUEST

url: /rest/v1/activities
URI parameters:
activityId: Parameter ID in the ROC
query parameter:
languageCode=FR

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "activityRocId": Activity ID in the ROC,
        "activityName": [
            {
                "name": "Name",
                "language": "Activity name language"
            }
        ],
        "activityShortCode": "Activity short code",
        "activeFlag": "Entity active or not",
        "editOrder": Entity order edition,
        "entityTypeId": Entity type ID
    },
    "error": {

    }
}

NETWORKS

This operation gets the network details by his id.

REQUEST

url: /rest/v1/networks
URI parameters:
networkId: Parameter ID in the ROC
query parameter:
languageCode=FR

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "networkRocId": Network ID in the ROC,
        "networkName": [
            {
                "name": "Network name",
                "language": "Network name language"
            }
        ],
        "networkShortCode": "Network Short Code",
        "activeFlag": "Entity active or not",
        "editOrder": Entity edition order,
        "entityTypeId": Entity type ID
    }
}

COUNTRIES

This operation gets the country details by his id.

REQUEST

url: /rest/v1/countries
URI parameters:
countryId: Parameter ID in the ROC

query parameter:

languageCode=FR

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "countryRocId": Country ID from the ROC,
        "countryName": [
            {
                "name": "Country name",
                "language": "Country name language"
            }
        ],
        "countryShortCode": "Country short code",
        "countryLongCode": "Country long code",
        "activeFlag": "Entity is active or not",
        "editOrder": Entity edition order,
        "entityTypeId": Entity type ID
    },
    "error": {

    }
}

CURRENCIES

This operation gets the currencies details by its id.

REQUEST

url: /rest/v1/currencies
URI parameters:
currencyId: Parameter ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "rocId": "Currency ID in the ROC",
        "currencyName": "Currency name",
        "currencyCode": "Cyrrency code",
        "activeInd": "Entity is active"
    },
    "error": {

    }
}

SCOPES

This operation gets the scopes details by its id.

REQUEST

url: /rest/v1/scopes
URI parameters:
scopeId: Parameter ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "scopeRocId": Scope ID in the ROC,
        "scopeName": "Scope Name",
        "scopeCode": "Scope Code",
        "scopeShortCode": "Scope short call",
        "activeFlag": "Entity active or not",
        "editOrder": Entity edition order
    },
    "error": {

    }
}

LANGUAGES

This operation gets the language details by his id.

REQUEST

url: /rest/v1/languages
URI parameters:
languageId: Parameter ID in the ROC

query parameter:

languageCode=DE

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "languageRocId": Language ID in the ROC,
        "languageName": [
            {
                "name": "Language name",
                "language": "Language name language"
            }
        ],
        "languageShortCode": "Language short code",
        "activeFlag": "Entity is active or not",
        "editOrder": Entity edition order,
        "entityTypeId": Entity type ID
    },
    "error": {

    }
}

SOFTWARES

This operation gets the software details by its id.

REQUEST

url: /rest/v1/softwares
URI parameters:
softwareId: Parameter ID in the ROC

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "softwareRocId": Software ROC ID,
        "softwareName": "Software name",
        "softwareShortCode": "Software short code",
        "softwareTypeId": Software type ID,
        "softwareNameType": "Software name type",
        "activeFlag": "Entity is active or not",
        "editOrder": "Entity edition order",
        "entityTypeId": Entity type ID
    },
    "error": {

    }
}

CBCR ACTIVITIES

This operation gets the CBCR Activity details by his id.

REQUEST

url: /rest/v1/cbcr-activities
URI parameters:
cbcrActivityId: Parameter ID in the ROC

query parameter:

languageCode=DE

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "cbcrActivityRocId": CBCR Activity ID in the ROC,
        "cbcrActivityName": [
            {
                "name": "CBCR Activity name",
                "language": "CBCR Activity name language"
            }
        ],
        "cbcrActivityShortCode": "Short CBCR Activity code",
        "activeFlag": "Entity is active or not",
        "editOrder": Entity edition order,
        "entityTypeId": Entity type ID
    },
    "error": {

    }
}

TAX REGIMES

This operation gets the tax regimes details by his id.

REQUEST

url: /rest/v1/tax-regimes
URI parameters:
taxRegimeId: Parameter ID in the ROC

query parameter:

languageCode=DE

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "taxRegimeRocId": Tax Regime ID in ROC,
        "taxRegimeName": [
            {
                "name": "Tax Regime name",
                "language": "Tax Regime name language"
            }
        ],
        "taxRegimeShortCode": "Tax Regime short code",
        "activeFlag": "Entity is active or not",
        "editOrder": Entity edit order,
        "entityTypeId": Entity type ID
    },
    "error": {}
}

ENTITY MANAGERS

This operation gets the Manager depending on the Entity ID.

REQUEST

url: /rest/v1/entity-managers

query parameter:

entityId=ROC ID of the entity

entityType=Type of the entity in ROC

languageCode=FR

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
        "entityManagerRocId": ROC ID of the Entity Manager,
        "roleCode": Role code of the manager,
        "roleName": Role Name of the manager,
        "firstName": "First Name of the manager",
        "lastName": "Last Name of the manager",
        "entityId": Entity ID in the ROC,
        "email": "email of the manager",
        "manager": is the person Manager,
        "scopeId": scope ID of the Entity Manager in the ROC
    },
    "error": {}
}

PERSON ROLES

This operation gets every Roles on Entities for an Employee.

REQUEST

url: /rest/v1/person-roles
URI parameters:

query parameter:

personId=ROC ID of the person

directorCode=Code of the director in ROC

languageCode=FR

RESPONSE

{
    "header": {
        "apiName": "{name of the API}",
        "apiversion": "{schema version following single digit format X}",
        "correlationId": "{correlationId conveyed all along the transaction}"
    },
    "data": {
      "roleCode": "code of the role of the person in the ROC (in the language requested in the query)",
      "roleKey": "key name of the role ",
      "roleName": "name of the role",
      "typeRoleId": ID of the type of Role,
      "editOrder": Entity edition order
    },
    "error": {}
}